Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SDK-3718] Create tree-shakable MsgPack module #1425

Merged
merged 4 commits into from
Nov 9, 2023

Conversation

lawrence-forooghian
Copy link
Collaborator

@lawrence-forooghian lawrence-forooghian commented Aug 21, 2023

Note: This PR is based on top of #1419; please review that one first.

This encapsulates the MessagePack functionality in a tree-shakable module. See commit messages for more details.

Resolves #1375.

@github-actions github-actions bot temporarily deployed to staging/pull/1425/features August 21, 2023 14:46 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1425/bundle-report August 21, 2023 14:47 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1425/typedoc August 21, 2023 14:47 Inactive
@lawrence-forooghian lawrence-forooghian force-pushed the 1375-msgpack-tree-shaking branch from 1dd7667 to f320e0a Compare August 21, 2023 18:31
@github-actions github-actions bot temporarily deployed to staging/pull/1425/features August 21, 2023 18:31 Inactive
@lawrence-forooghian lawrence-forooghian changed the title 1375 msgpack tree shaking [SDK-3718] Create tree-shakeable MsgPack module Aug 21, 2023
@github-actions github-actions bot temporarily deployed to staging/pull/1425/typedoc August 21, 2023 18:32 Inactive
@lawrence-forooghian lawrence-forooghian changed the title [SDK-3718] Create tree-shakeable MsgPack module [SDK-3718] Create tree-shakable MsgPack module Aug 21, 2023
@github-actions github-actions bot temporarily deployed to staging/pull/1425/bundle-report August 21, 2023 18:32 Inactive
@lawrence-forooghian lawrence-forooghian force-pushed the 1375-msgpack-tree-shaking branch from 00fcf72 to f320e0a Compare August 22, 2023 12:18
@github-actions github-actions bot temporarily deployed to staging/pull/1425/features August 22, 2023 12:18 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1425/bundle-report August 22, 2023 12:19 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1425/typedoc August 22, 2023 12:19 Inactive
@lawrence-forooghian lawrence-forooghian force-pushed the 1375-msgpack-tree-shaking branch from f320e0a to 46aa0c9 Compare August 22, 2023 17:48
@github-actions github-actions bot temporarily deployed to staging/pull/1425/features August 22, 2023 17:48 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1425/typedoc August 22, 2023 17:49 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1425/bundle-report August 22, 2023 17:49 Inactive
@lawrence-forooghian lawrence-forooghian force-pushed the 1375-msgpack-tree-shaking branch from 46aa0c9 to dee1c19 Compare August 22, 2023 19:45
@github-actions github-actions bot temporarily deployed to staging/pull/1425/features August 22, 2023 19:46 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1425/bundle-report August 22, 2023 19:47 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1425/typedoc August 22, 2023 19:47 Inactive
@lawrence-forooghian lawrence-forooghian force-pushed the 1375-msgpack-tree-shaking branch from dee1c19 to 6766766 Compare August 22, 2023 20:31
@github-actions github-actions bot temporarily deployed to staging/pull/1425/features August 22, 2023 20:31 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1425/typedoc August 22, 2023 20:32 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1425/bundle-report August 22, 2023 20:33 Inactive
@lawrence-forooghian lawrence-forooghian marked this pull request as ready for review August 23, 2023 11:59
@lawrence-forooghian lawrence-forooghian force-pushed the 1375-msgpack-tree-shaking branch from 6766766 to 3a4867d Compare August 23, 2023 19:36
@github-actions github-actions bot temporarily deployed to staging/pull/1425/features September 14, 2023 12:53 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1425/bundle-report September 14, 2023 12:54 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1425/typedoc September 14, 2023 12:54 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1425/features October 26, 2023 16:41 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1425/typedoc October 26, 2023 16:42 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1425/bundle-report October 26, 2023 16:42 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1425/features October 26, 2023 17:23 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1425/typedoc October 26, 2023 17:24 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1425/bundle-report October 26, 2023 17:24 Inactive
@lawrence-forooghian lawrence-forooghian marked this pull request as draft November 1, 2023 18:32
Base automatically changed from 1396-Crypto-tree-shaking to integration/v2 November 7, 2023 11:58
The property is already manipulated earlier in this method. Duplication
introduced in 4f66064; seems unintentional.
Preparation for #1375 (making MessagePack functionality tree-shakable).
The _MsgPack assignment becomes the only place that
Platform.Config.msgpack gets accessed. All other uses now instead access
_MsgPack.

Preparation for #1375 (making MessagePack functionality tree-shakable).
We move the MessagePack functionality into a tree-shakable MsgPack
module.

Resolves #1375.
Copy link
Member

@owenpearson owenpearson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

I wondered for a bit whether it might be simpler to guard optional modules behind a getter like:

get _MsgPack() {
  return this._MsgPackModule || Utils.throwMissingModuleError('MsgPack');
}

but I guess that would make things complicated when we're passing msgpack into functions like we do in a couple of places

@lawrence-forooghian lawrence-forooghian merged commit a9cc07d into integration/v2 Nov 9, 2023
11 checks passed
@lawrence-forooghian lawrence-forooghian deleted the 1375-msgpack-tree-shaking branch November 9, 2023 15:40
@VeskeR VeskeR mentioned this pull request Mar 1, 2024
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants